

#ifndef __I_READ_FILE_H_INCLUDED__
#define __I_READ_FILE_H_INCLUDED__

#include "IReferenceCounted.h"

namespace screa
{
namespace io
{

	//! Interface providing read acess to a file.
	class IReadFile  : public virtual IReferenceCounted
	{
	public:
		//! Reads an amount of bytes from the file.
		/** \param buffer Pointer to buffer where read bytes are written to.
		\param sizeToRead Amount of bytes to read from the file.
		\return How much bytes were read. */
		virtual int read(void* buffer, unsigned int sizeToRead) = 0;

		//! Changes position in file
		/** \param finalPos Destination position in the file.
		\param relativeMovement If set to true, the position in the file is
		changed relative to current position. Otherwise the position is changed
		from beginning of file.
		\return True if successful, otherwise false. */
		virtual bool seek(long finalPos, bool relativeMovement = false) = 0;

		//! Get size of file.
		/** \return Size of the file in bytes. */
		virtual long getSize() const = 0;

		//! Get the current position in the file.
		/** \return Current position in the file in bytes. */
		virtual long getPos() const = 0;

		//! Get name of file.
		/** \return File name as zero terminated character string. */
		virtual const char* getFileName() const = 0;
	};

	//! Internal function, please do not use.
	IReadFile* createReadFile(const char* fileName);
	//! Internal function, please do not use.
	//IReadFile* createLimitReadFile(const char* fileName, IReadFile* alreadyOpenedFile, long areaSize);
	//! Internal function, please do not use.
	//IReadFile* createMemoryReadFile(void* memory, long size, const char* fileName, bool deleteMemoryWhenDropped);

} // end namespace io
} // 

#endif

